<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD><meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
<title>Hyperlink Detectors</title>
<style type="text/css">@import url("file:/home/moovida/rcpdevelopment/eclipse/configuration/org.eclipse.osgi/bundles/488/1/.cp/book.css");</style>
<style type="text/css">@import url("file:/home/moovida/rcpdevelopment/eclipse/configuration/org.eclipse.osgi/bundles/505/1/.cp/schema.css");</style>
</HEAD>
<BODY>
<H1 style="text-align:center">Hyperlink Detectors</H1>
<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Identifier: </h6>org.eclipse.ui.workbench.texteditor.hyperlinkDetectors<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Since: </h6>3.3
<p></p>

<h6 class="CaptionFigColumn SchemaHeader">Description: </h6>This extension point is used to plug in hyperlink detectors.<p></p>
<h6 class="CaptionFigColumn SchemaHeader">Configuration Markup:</h6>
<p></p>
<p class="code SchemaDtd">&lt;!ELEMENT <a name="e.extension">extension</a> (<a href="#e.hyperlinkDetector">hyperlinkDetector</a>+)&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST extension</p>
<p class="code SchemaDtdAttlist">point&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;CDATA #IMPLIED</p><p class="code SchemaDtdAttlist">name&nbsp;&nbsp;CDATA #IMPLIED</p>&gt;</p>
<p></p>
<ul class="ConfigMarkupAttlistDesc">
<li><b>point</b> - a fully qualified identifier of the target extension point</li>
<li><b>id</b> - an optional identifier of the extension instance</li>
<li><b>name</b> - an optional name of the extension instance</li>
</ul>
<br><p class="code SchemaDtd">&lt;!ELEMENT <a name="e.hyperlinkDetector">hyperlinkDetector</a> EMPTY&gt;</p>
<p class="code SchemaDtd">&lt;!ATTLIST hyperlinkDetector</p>
<p class="code SchemaDtdAttlist">id&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">name&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">description&nbsp;&nbsp;CDATA #IMPLIED</p><p class="code SchemaDtdAttlist">targetId&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;IDREF #REQUIRED</p><p class="code SchemaDtdAttlist">class&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;CDATA #REQUIRED</p><p class="code SchemaDtdAttlist">activate&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;(true | false) "true"</p><p class="code SchemaDtdAttlist">modifierKeys&nbsp;CDATA #IMPLIED</p>&gt;</p>
<p></p>
<ul class="ConfigMarkupAttlistDesc">
<li><b>id</b> - a unique id that will be used to identify this hyperlink detector</li>
<li><b>name</b> - a name that allows to identify this hyperlink detector in the UI</li>
<li><b>description</b> - the translatable description for this hyperlink detector. Currently, this description isn't displayed anywhere in the UI by the Eclipse SDK.</li>
<li><b>targetId</b> - the id of the hyperlink target which has been registered via <code>org.eclipse.ui.workbench.texteditor.hyperlinkTargets</code> extension point</li>
<li><b>class</b> - the fully qualified class name implementing the interface <code>org.eclipse.jface.text.hyperlink.IHyperlinkDetector</code>. Subclass <code>org.eclipse.jface.text.hyperlink.AbstractHyperlinkDetector</code> if you want to access context that is provided by the target.</li>
<li><b>activate</b> - an attribute that tells whether to activate the contributing plug-in when hyperlink detection takes place in the given target</li>
<li><b>modifierKeys</b> - the modifier keys that need to be pressed for this hyperlink detector to be active. Valid values are: "Alt", "Ctrl", "Shift", "Command", "M1", "M2", "M3", "M4" and a combination of them separated by "+". <i>Note that "Shift" by itself is not allowed because "Shift" + left mouse click sets the selection.</i> If this attribute is not specified then the default modifier keys are used.</li>
</ul>
<br><h6 class="CaptionFigColumn SchemaHeader">Examples: </h6>The following is an example of a hyperlink detector definition:

<pre class="Example"><span class="code SchemaTag">
&lt;extension
  point=</span><span class="code SchemaCstring">&quot;org.eclipse.ui.workbench.texteditor.hyperlinkDetectors&quot;</span><span class="code SchemaTag">&gt;
  &lt;hyperlinkDetector
    id=</span><span class="code SchemaCstring">&quot;org.eclipse.example.jdt.internal.debug.ui.JavaHyperlinkDetector&quot;</span><span class="code SchemaTag">
    targetId=</span><span class="code SchemaCstring">&quot;org.eclipse.jdt.ui.javaCode&quot;</span><span class="code SchemaTag">
    class=</span><span class="code SchemaCstring">&quot;org.eclipse.example.jdt.internal.debug.ui.JavaHyperlinkDetector&quot;</span><span class="code SchemaTag">
    name=</span><span class="code SchemaCstring">&quot;%javaHyperlinkDetector&quot;</span><span class="code SchemaTag">&gt;
  &lt;/hyperlinkDetector&gt;
&lt;/extension&gt;
</span></pre>
<p></p>

<br>
<p class="note SchemaCopyright">
Copyright (c) 2007, 2008 IBM Corporation and others.<br>
All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which accompanies this distribution, and is available at <a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a>

</p>
</BODY>
</HTML>
